Interface EIGRPProcess

All Superinterfaces:
IPCObject, Process, RoutingProtocol
All Known Implementing Classes:
EIGRPProcessImpl

public interface EIGRPProcess extends RoutingProtocol
Information provided by the PKI file:

    \class EigrpProcess
    
    \brief EigrpProcess is the process that handles the individual EIGRP AS process.
    
    \example network().getDevice("Router0").getProcess("EigrpMainProcess").getEigrpProcess(100)
    
Author:
Auto-generated
  • Method Details

    • getASNumber

      int getASNumber()
      Information provided by the PKI file:
      
          \brief Returns the AS number of this EIGRP process.
          
          \return int, the AS number of this EIGRP process.
          
              
      Returns:
      int Returns a int
    • setKs

      void setKs(int k1, int k2, int k3, int k4, int k5)
      Information provided by the PKI file:
      
          \brief Sets the K-values to the specified values.
          
          \param k1, the K1 value.
          \param k2, the K2 value.
          \param k3, the K3 value.
          \param k4, the K4 value.
          \param k5, the K5 value.
          
              
      Parameters:
      k1 - Takes in a parameter of k1
      k2 - Takes in a parameter of k2
      k3 - Takes in a parameter of k3
      k4 - Takes in a parameter of k4
      k5 - Takes in a parameter of k5
    • setVariance

      void setVariance(int variance)
      Information provided by the PKI file:
      
          \brief Sets the variance to the specified value.
          
          \param variance, the variance value.
          
              
      Parameters:
      variance - Takes in a parameter of variance
    • getVariance

      int getVariance()
      Information provided by the PKI file:
      
          \brief Returns the variance of this EIGRP process.
          
          \return int, the variance of this EIGRP process.
          
              
      Returns:
      int Returns a int
    • setAutoSummary

      void setAutoSummary(boolean bAutoSum)
      Information provided by the PKI file:
      
          \brief Enables or disables auto summary on this EIGRP process.
          
          \param bAutoSum, true to enable auto summary, false to disable it.
          
              
      Parameters:
      bAutoSum - Takes in a parameter of bAutoSum
    • getAutoSummary

      boolean getAutoSummary()
      Information provided by the PKI file:
      
          \brief Returns true if auto summary is enabled on this EIGRP process, otherwise false.
          
          \return bool, true if auto summary is enabled on this EIGRP process, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setDefaultPassiveInt

      void setDefaultPassiveInt(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables default passive interface on this EIGRP process.
          
          \param bEnable, true to enable default passive interface on this EIGRP process, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • getDefaultPassiveInt

      boolean getDefaultPassiveInt()
      Information provided by the PKI file:
      
          \brief Returns true if default passive interface is enabled on this EIGRP process, otherwise false.
          
          \return bool, true if default passive interface is enabled on this EIGRP process, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setPassiveInt

      void setPassiveInt(String portName, boolean bPassive)
      Information provided by the PKI file:
      
          \brief Enables or disables passive interface on the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param bPassive, true to enable passive interface, false to disable it.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      bPassive - Takes in a parameter of bPassive
    • isPassiveInt

      boolean isPassiveInt(String portName)
      Information provided by the PKI file:
      
          \brief Returns true if passive interface is enabled on the specified port, otherwise false.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if passive interface is enabled on the specified port, otherwise false.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • setIntAdminDistance

      void setIntAdminDistance(int adminDistance)
      Information provided by the PKI file:
      
          \brief Sets the internal administrative distance on this EIGRP process.
          
          \param adminDistance, the internal administrative distance.
          
              
      Parameters:
      adminDistance - Takes in a parameter of adminDistance
    • setExtAdminDistance

      void setExtAdminDistance(int adminDistance)
      Information provided by the PKI file:
      
          \brief Sets the external administrative distance on this EIGRP process.
          
          \param adminDistance, the external administrative distance.
          
              
      Parameters:
      adminDistance - Takes in a parameter of adminDistance
    • addConfiguredNetwork

      void addConfiguredNetwork(IPAddress ipAddress, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Adds the network with the specified network address and mask to this EIGRP process.
          
          \param ipAddress, the network address.
          \param mask, the network mask.
          
              
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
      mask - Takes in a parameter of mask
    • removeConfiguredNetwork

      void removeConfiguredNetwork(IPAddress ipAddress, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Removes the network with the specified network address and mask from this EIGRP process.
          
          \param ipAddress, the network address of interest.
          \param mask, the network mask of interest.
          
              
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
      mask - Takes in a parameter of mask
    • getConfiguredNetworkCount

      int getConfiguredNetworkCount()
      Information provided by the PKI file:
      
          \brief Returns the number of networks in this EIGRP process.
          
          \return int, the number of networks in this EIGRP process.
          
              
      Returns:
      int Returns a int
    • addSummaryAddress

      boolean addSummaryAddress(String portName, IPAddress ipAddress, IPAddress subnet, int adminDistance)
      Information provided by the PKI file:
      
          \brief Adds a summary aggregate address to the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param ipAddress, the summary IP address.
          \param subnet, the summary subnet mask.
          \param adminDistance, the administrative distance.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      ipAddress - Takes in a parameter of ipAddress
      subnet - Takes in a parameter of subnet
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • removeSummaryAddress

      boolean removeSummaryAddress(String portName, IPAddress ipAddress, IPAddress subnet, int adminDistance)
      Information provided by the PKI file:
      
          \brief Removes a summary aggregate address to the specified port.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param ipAddress, the summary IP address.
          \param subnet, the summary subnet mask.
          \param adminDistance, the administrative distance.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      ipAddress - Takes in a parameter of ipAddress
      subnet - Takes in a parameter of subnet
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • getSummaryAddressCount

      int getSummaryAddressCount(String portName)
      Information provided by the PKI file:
      
          \brief Returns the number of summary aggregate addresses on the specified port.
          
          \param portName             portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return int, the number of summary aggregate addresses on the specified port.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      int Returns a int
    • getSummaryAddressAt

      EIGRPSummaryAddress getSummaryAddressAt(String portName, int as, int index)
      Information provided by the PKI file:
      
          \brief Returns the summary aggregate address on the specified port, AS number, and index.
          
          \param portName             portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param as, the autonomous system of the summary aggregate address of interest.
          \param index, the index of the summary aggregate address of interest.
          
          \return EigrpSummaryAddress, the EigrpSummaryAddress object on the specified port, AS number, and index.
          
              
      Parameters:
      portName - Takes in a parameter of portName
      as - Takes in a parameter of as
      index - Takes in a parameter of index
      Returns:
      EIGRPSummaryAddress Returns a EIGRPSummaryAddress
    • getTopologyTable

      EIGRPTopologyTable getTopologyTable()
      Information provided by the PKI file:
      
          \brief Returns the topology table of this EIGRP process.
          
          \return EigrpTopologyTable, the EigrpTopologyTable object of this EIGRP process.
          
              
      Returns:
      EIGRPTopologyTable Returns a EIGRPTopologyTable
    • getNeighborTable

      EIGRPNeighborTable getNeighborTable()
      Information provided by the PKI file:
      
          \brief Returns the neighbor table of this EIGRP process.
          
          \return EigrpNeighborTable, the EigrpNeighborTable object of this EIGRP process.
          
              
      Returns:
      EIGRPNeighborTable Returns a EIGRPNeighborTable